<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>EnTech FPK: AsyncResult&lt; Result &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">EnTech FPK
   &#160;<span id="projectnumber">1</span>
   </div>
   <div id="projectbrief">FRC Programming Kit by the EnTech 281 GreenVillains</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_async_result-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">AsyncResult&lt; Result &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="_async_result_8hpp_source.html">AsyncResult.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for AsyncResult&lt; Result &gt;:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_async_result.png" usemap="#AsyncResult&lt; Result &gt;_map" alt=""/>
  <map id="AsyncResult&lt; Result &gt;_map" name="AsyncResult&lt; Result &gt;_map">
<area href="class_async_status.html" alt="AsyncStatus" shape="rect" coords="0,0,140,24"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af459c92d8be03a170eca11e65252242f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_async_result.html#af459c92d8be03a170eca11e65252242f">AsyncResult</a> ()</td></tr>
<tr class="separator:af459c92d8be03a170eca11e65252242f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1658527ae8ff4841743634793e17a40d"><td class="memItemLeft" align="right" valign="top">virtual Result&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_async_result.html#a1658527ae8ff4841743634793e17a40d">GetResult</a> () const =0</td></tr>
<tr class="separator:a1658527ae8ff4841743634793e17a40d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad81030298716efd65c60a0e23aa1d85f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_async_result.html#ad81030298716efd65c60a0e23aa1d85f">TryGetResult</a> (Result &amp;result) const </td></tr>
<tr class="separator:ad81030298716efd65c60a0e23aa1d85f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_async_status"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_async_status')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_async_status.html">AsyncStatus</a></td></tr>
<tr class="memitem:a67ac5c0e72643ec2abaf9c7e43592d0d inherit pub_methods_class_async_status"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_async_status.html#a67ac5c0e72643ec2abaf9c7e43592d0d">AsyncStatus</a> ()</td></tr>
<tr class="separator:a67ac5c0e72643ec2abaf9c7e43592d0d inherit pub_methods_class_async_status"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cd78092e555f800876ad2eae6e969b6 inherit pub_methods_class_async_status"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_async_status.html#a9cd78092e555f800876ad2eae6e969b6">~AsyncStatus</a> ()</td></tr>
<tr class="separator:a9cd78092e555f800876ad2eae6e969b6 inherit pub_methods_class_async_status"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2af6f8a852b33b13be5025716facb0cc inherit pub_methods_class_async_status"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_async_status.html#a2af6f8a852b33b13be5025716facb0cc">GetIsFinished</a> () const =0</td></tr>
<tr class="separator:a2af6f8a852b33b13be5025716facb0cc inherit pub_methods_class_async_status"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80260d82f0e783270531fdb233f7b0a7 inherit pub_methods_class_async_status"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_async_status.html#a80260d82f0e783270531fdb233f7b0a7">Cancel</a> ()=0</td></tr>
<tr class="separator:a80260d82f0e783270531fdb233f7b0a7 inherit pub_methods_class_async_status"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename Result&gt;<br/>
class AsyncResult&lt; Result &gt;</h3>

<p>The <a class="el" href="class_async_result.html">AsyncResult</a> class is used for asynchronous operations.</p>
<p>This class is untested. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="af459c92d8be03a170eca11e65252242f"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Result &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_async_result.html">AsyncResult</a>&lt; Result &gt;::<a class="el" href="class_async_result.html">AsyncResult</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Constructor for <a class="el" href="class_async_result.html">AsyncResult</a>. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a1658527ae8ff4841743634793e17a40d"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Result &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual Result <a class="el" href="class_async_result.html">AsyncResult</a>&lt; Result &gt;::GetResult </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Gets the result value.</p>
<dl class="section return"><dt>Returns</dt><dd>The result value. </dd></dl>

</div>
</div>
<a class="anchor" id="ad81030298716efd65c60a0e23aa1d85f"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Result &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="class_async_result.html">AsyncResult</a>&lt; Result &gt;::TryGetResult </td>
          <td>(</td>
          <td class="paramtype">Result &amp;&#160;</td>
          <td class="paramname"><em>result</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Trys to get the result value.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">result</td><td>A reference to where the output result value will be stored. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>If the async operation as finished. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>C:/Users/Sam/Projects/FRC/Libraries/Fpk/Entech-Fpk-Subscribers/Entech-Fpk/<a class="el" href="_async_result_8hpp_source.html">AsyncResult.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 12 2013 16:46:49 for EnTech FPK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
